<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Biriani</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Biriani</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">class Biriani</p>
		<p class="notes">
			Located in <a class="field" href="_Biriani.php.html">/Biriani.php</a> (line <span class="field">12</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#BIRIANI_CACHE_PREFIX" title="details" class="const-name">BIRIANI_CACHE_PREFIX</a> = 					<span class="var-type">'BirianiCache'</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#BIRIANI_CACHE_SUFFIX" title="details" class="const-name">BIRIANI_CACHE_SUFFIX</a> = 					<span class="var-type">'.bc'</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$cache_duration" title="details" class="var-name">$cache_duration</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$cache_location" title="details" class="var-name">$cache_location</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$url" title="details" class="var-name">$url</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																												
												<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#clear_cache" title="details" class="method-name">clear_cache</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#execute" title="details" class="method-name">execute</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#extract_data" title="details" class="method-name">extract_data</a>
											(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#fetch_data" title="details" class="method-name">fetch_data</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>
										<a href="#get_cached_response" title="details" class="method-name">get_cached_response</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#get_cache_duration" title="details" class="method-name">get_cache_duration</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#get_cache_file_name" title="details" class="method-name">get_cache_file_name</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span> = <span class="var-default">&quot;&quot;</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_cache_location" title="details" class="method-name">get_cache_location</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">Biriani::IExtractable</span>
										<a href="#get_extractor" title="details" class="method-name">get_extractor</a>
											(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_url" title="details" class="method-name">get_url</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#is_cache_valid" title="details" class="method-name">is_cache_valid</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_cached_response" title="details" class="method-name">set_cached_response</a>
											(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_cache_duration" title="details" class="method-name">set_cache_duration</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$duration</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_cache_location" title="details" class="method-name">set_cache_location</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_url" title="details" class="method-name">set_url</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$cache_duration" id="$cache_duration"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$cache_duration</span>
			 = <span class="var-default"> 3600</span>			(line <span class="line-number">21</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$cache_location" id="$cache_location"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$cache_location</span>
			 = <span class="var-default"> &quot;/tmp&quot;</span>			(line <span class="line-number">27</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$url" id="$url"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$url</span>
						(line <span class="line-number">33</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodclear_cache" id="clear_cache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">clear_cache</span> (line <span class="line-number">234</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears all the data from cache</p>
	<ul class="tags">
				<li><span class="field">return:</span> false upon failure</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			clear_cache
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodexecute" id="execute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">execute</span> (line <span class="line-number">169</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			execute
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodextract_data" id="extract_data"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">extract_data</span> (line <span class="line-number">188</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			extract_data
		</span>
					(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>
				<span class="var-name">$response</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfetch_data" id="fetch_data"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">fetch_data</span> (line <span class="line-number">118</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			fetch_data
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_cached_response" id="get_cached_response"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_cached_response</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets response from cache</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>
		<span class="method-name">
			get_cached_response
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$file</span><span class="var-description">: cache file</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_cache_duration" id="get_cache_duration"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_cache_duration</span> (line <span class="line-number">55</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			get_cache_duration
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_cache_file_name" id="get_cache_file_name"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_cache_file_name</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">gen cache file name from key</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			get_cache_file_name
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span> = <span class="var-default">&quot;&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$key</span><span class="var-description">: cache file name from key</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_cache_location" id="get_cache_location"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_cache_location</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_cache_location
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_extractor" id="get_extractor"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_extractor</span> (line <span class="line-number">199</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Biriani::IExtractable</span>
		<span class="method-name">
			get_extractor
		</span>
					(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Biriani::Biriani_Response</span>
				<span class="var-name">$response</span><span class="var-description">: response Response object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_url" id="get_url"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_url</span> (line <span class="line-number">106</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_url
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodis_cache_valid" id="is_cache_valid"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">is_cache_valid</span> (line <span class="line-number">140</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">checks if any cache is valid in the supplied file</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			is_cache_valid
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$file</span><span class="var-description">: file name where cache exists</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_cached_response" id="set_cached_response"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_cached_response</span> (line <span class="line-number">157</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Saves a Response to cache for later use</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_cached_response
		</span>
					(<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>&nbsp;<span class="var-name">$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Biriani/Biriani_Response.html">Biriani_Response</a></span>
				<span class="var-name">$response</span><span class="var-description">: response object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_cache_duration" id="set_cache_duration"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_cache_duration</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_cache_duration
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$duration</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$duration</span><span class="var-description">: duration Cache duration</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_cache_location" id="set_cache_location"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_cache_location</span> (line <span class="line-number">66</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_cache_location
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$location</span><span class="var-description">: location</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_url" id="set_url"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_url</span> (line <span class="line-number">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_url
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span><span class="var-description">: url</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constBIRIANI_CACHE_PREFIX" id="BIRIANI_CACHE_PREFIX"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BIRIANI_CACHE_PREFIX</span>
			 = <span class="const-default">'BirianiCache'</span>
			(line <span class="line-number">14</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constBIRIANI_CACHE_SUFFIX" id="BIRIANI_CACHE_SUFFIX"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BIRIANI_CACHE_SUFFIX</span>
			 = <span class="const-default">'.bc'</span>
			(line <span class="line-number">15</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sat, 04 Feb 2012 04:13:41 +0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>